using System;
using System.Collections.Generic;
using System.Text;

namespace Sandia.MVCFramework.Request
{
    /// <summary>
    /// Request parameter that specifies the filename
    /// to import from
    /// </summary>
    public class ShowProgressBarRequestParameter : AbstractStandardRequestParameter
    {
        /// <summary>
        /// Human readable name of the parameter
        /// </summary>
        public static string NAME = "ShowProgressBarRequestParameter";

        /// <summary>
        /// Constructor
        /// </summary>
        /// <param name="progressTitle">The title to use in the associated progress bar window;
        /// an empty string ("") means that the progress bar should be disabled</param>
        public ShowProgressBarRequestParameter(string progressTitle)
            : base()
        {
            this.Data = progressTitle;
        }

        /// <summary>
        /// Default constrcutor - progress bar is disabled (Data is set to "")
        /// </summary>
        public ShowProgressBarRequestParameter()
            : base()
        {
            this.Data = "";
        }

        /// <summary>
        /// Initializes name of the request parameter
        /// </summary>
        /// <returns>Name of the request parameter</returns>
        protected override string initName()
        {
            return ShowProgressBarRequestParameter.NAME;
        }
    }
}
